docs: document Java dedup agent setup#848
Merged
officialasishkumar merged 7 commits intomainfrom Apr 30, 2026
Merged
Conversation
13 tasks
officialasishkumar
force-pushed
the
codex/java-dedup-agent
branch
from
ed68045 to
a29002b
Compare
officialasishkumar
force-pushed
the
codex/java-dedup-agent
branch
3 times, most recently
from
ed6514b to
2674b14
Compare
khareyash05
approved these changes
Apr 30, 2026
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Latest io.keploy:keploy-sdk release on Maven Central with the shaded dedup agent jar. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
officialasishkumar
force-pushed
the
codex/java-dedup-agent
branch
from
f50075d to
dc486ae
Compare
Reading the Java dedup docs end-to-end as a fresh user, several sections were noise: - TCP-fallback prose + KEPLOY_JACOCO_HOST/PORT + keploy.jacoco.* JVM properties + --pass-through-ports note. The SDK transparently falls back when the in-process JaCoCo runtime API is unavailable (rare); making the user think about it on page 1 of the setup is unhelpful. Removed entirely; the fallback path still works, it's just no longer in the user's face. - /tmp/coverage_control.sock and /tmp/coverage_data.sock paths exposed in the main flow. Internal protocol detail; users don't need to know the socket names to attach -javaagent. - "Hardened Docker runs are validated with non-root user, read-only root filesystem, dropped capabilities, no-new-privileges, ..." paragraph — that's the CI test matrix bragging, not user instruction. Trimmed to one sentence: "restricted containers work as long as /tmp stays writable." Also fixed two real gaps a user actually hits: - How to obtain jacocoagent.jar. Both docs said "attach -javaagent: /path/to/jacocoagent.jar" but never told the user where to get the file. Added a maven-dependency-plugin <execution> next to the existing keploy-sdk copy block that pulls org.jacoco:org.jacoco.agent:0.8.12:jar:runtime to target/jacocoagent.jar. - JaCoCo version pin (0.8.12) is now explicit in Requirements + the maven snippet, so users on older versions know what we test against. - One-line description of what dedupData.yaml and duplicates.yaml contain, instead of just naming them. Net diff: deduplication.md -11 lines, java.md -10 lines, both denser and easier to follow. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Remove the extra JaCoCo version note from the dynamic dedup docs now that the tested version is already covered in requirements and the Maven copy snippet. Also avoid spaced em dashes in the updated Java dedup docs and accept Karaf as a Vale vocabulary term so the changed docs lint cleanly. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
officialasishkumar
force-pushed
the
codex/java-dedup-agent
branch
from
3a1f6a6 to
9cfe442
Compare
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What has changed?
Documents the Java dynamic dedup runtime-agent flow using
io.keploy:keploy-sdk:2.0.6. The docs now say the Keploy SDK should be copied as a Java agent, not added as an application dependency, and application code should not import Keploy classes.The Java guide covers:
-javaagentKEPLOY_JAVA_CLASS_DIRSKEPLOY_JAVA_CLASS_DIRSso dependency classes do not participate in dedup signatureskeploy test --dedup --language javaThis PR Resolves # NA
Type of change
How Has This Been Tested?
git diff --check -- versioned_docs/version-4.0.0/keploy-cloud/deduplication.md versioned_docs/version-4.0.0/server/sdk-installation/java.md2.0.6for theio.keploy:keploy-sdkMaven coordinate in bothkeploy-cloud/deduplication.mdandserver/sdk-installation/java.md.2.0.6as the latest/release version forio.keploy:keploy-sdk, and the2.0.6jar returns HTTP 200 from Maven Central.2.0.6jar manifest hasPremain-Class: io.keploy.dedup.KeployDedupAgentandImplementation-Version: 2.0.6.v2.0.6is marked latest and has the same jar assets attached.KEPLOY_JAVA_CLASS_DIRS=/app/classes, matching the validated samples-java Dropwizard Docker fix.running-keploy/keploy-karaf.md) was bumped fromio.keploy.agent-2.0.1.jartoio.keploy.agent-2.0.2.jar. This is a separate S3-hosted Karaf record/test agent distribution, not the Maven Central dynamic-dedupkeploy-sdkartifact.yarn install --frozen-lockfile,yarn build, and Vale checks for the Java SDK installation and deduplication docs.Related PRs:
Checklist: